home *** CD-ROM | disk | FTP | other *** search
/ Aminet 13 / Aminet 13 - August 1996.iso / Aminet / comm / fido / MM_AntiBomb010.lha / MM / Docs / MM_AntiBomb.Doc < prev   
Text File  |  1996-05-04  |  8KB  |  268 lines
  1.  
  2.  
  3.  
  4.                                   7   7  7   7
  5.                                   77 77  77 77
  6.                                   7 7 7  7 7 7
  7.                                   7   7  7   7
  8.                                   7   7  7   7
  9.  
  10.  
  11.                    7   7   7 77777 777 7777   777  7   7 7777
  12.                   7 7  77  7   7    7  7   7 7   7 77 77 7   7
  13.                  77777 7 7 7   7    7  7777  7   7 7 7 7 7777
  14.                  7   7 7  77   7    7  7   7 7   7 7   7 7   7
  15.                  7   7 7   7   7   777 7777   777  7   7 7777
  16.  
  17.  
  18.                            7   7   77        7   77
  19.                            7   7  7  7      77  7  7
  20.                            7   7  7  7     7 7  7  7
  21.                             7 7   7  7       7  7  7
  22.                              7     77   7    7   77
  23.  
  24.  
  25.  
  26.  
  27.                            (C)  1996  Kent B. Hansen
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  1. Introduction
  34.  ===============
  35.  
  36.   1.1 Legal stuff
  37.   ---------------
  38.  
  39.    MM_AntiBomb is an Arexx-script for Mail Manager by Pino Aliberti.
  40.  
  41.    The programs and files in this distribution are freely distributable, but are
  42.    also Copyright (c) Kent B. Hansen.  They may be freely distributed as long as
  43.    no more than a nominal fee is charged to cover time and copying costs.
  44.  
  45.    No commercial usage is  permitted without  written permission from the author
  46.    Everything in this distribution must be kept together, in original unmodified
  47.    form.
  48.  
  49.  
  50.    MM_AntiBomb  is  mailware  :-).   This means if you use it, please write me a
  51.    short  mail.   You know, it is frustrating to write programs and there are no
  52.    responses from the users if they like it or not...
  53.  
  54.  
  55.    Accepting these few points is the only condition for using MM_AntiBomb...
  56.  
  57.  
  58.  
  59.    =============================================================================
  60.    The  author is not responsible for any problems caused by using this program!
  61.    =============================================================================
  62.  
  63.  
  64.  
  65.   1.2 General stuff
  66.   -----------------
  67.  
  68.    I  am  not  the  best  in  writing  doc.  This docs are a bit short I have to
  69.    appolognize, but I hope you'll understand it anyway...  Especially my English
  70.    and the typo's ;-)
  71.  
  72.    If there is  anybody out there  who is able to &  wants translate the docs to
  73.    his own language, please do so and send them to me! I'll add them to the next
  74.    release.
  75.  
  76.  
  77.  
  78.  
  79.  
  80.   1.3 Author
  81.   ----------
  82.  
  83.    If  you  have  suggestions  or remarks about this program, or if you find any
  84.    bugs, please let me know.
  85.  
  86.  
  87.    Contacting the author:
  88.  
  89.      Internet .. :  kbh@imada.ou.dk
  90.      FidoNet ... :  2:237/30.0
  91.      AmigaNet .. :  39:140/103.0
  92.  
  93.      Snail-mail  :  Kent B. Hansen
  94.                     Niels Juels Alle 59
  95.                     DK-5250 Odense SV
  96.                     Denmark
  97.                     Tel. +45-63120212
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  2. Features
  104.  ===========
  105.  
  106.   MM_AntiBomb...
  107.  
  108.      ... checks the compress-ratio of mail-packets before unpacking them
  109.      ... moves  packets  with  a ratio higher that the configured maximum to the
  110.          bad-directory
  111.      ... user configurable archiver-information
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  3. Installation
  118.  ===============
  119.  
  120.   1. Copy the files to the related MM:-directories.
  121.  
  122.   2. Make sure you have installed rexxsupport.library in LIBS:.
  123.  
  124.   2. Adjust the cfg to your own needs.
  125.  
  126.   3. Add it as a beforecmd in MM_ImportPlus:
  127.  
  128.          #BEFORECMD   rx MM:Rexx/MM_AntiBomb.rexx
  129.  
  130.      or first in your import-batch or whatever else you use.
  131.  
  132.  
  133.  
  134.   As  you  may  have seen, there's a second script called "MM_AntiBomb.rexx.cmp"
  135.   included.   This  is  a exacltly the same script as "MM_AntiBomb.rexx" itself,
  136.   except that it was compressed with "CompressRexx v2.1".
  137.  
  138.   On  slow  machines, it might be useful to replace the uncompressed script with
  139.   the  compressed one because it is slightly faster...  But please test it first
  140.   with  the  uncompressed version, because if an error occurs, finding the error
  141.   due to error-reports of the compressed script is nearly impossible!
  142.  
  143.   There's  also  included  an executable version of the script.  This version is
  144.   compiled with "CompressRexx v2.1" and can be made resident.
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  4. Usage
  151.  ========
  152.  
  153.   [RX] MM_AntiBomb[.rexx]
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  5. Configuration
  160.  ================
  161.  
  162.  
  163.   5.1 #(NO)DEBUG
  164.   ---------------
  165.  
  166.    Enables/disables logging of all checked mail-packets.  Default is #NODEBUG.
  167.  
  168.  
  169.  
  170.   5.2 #LIST <path+file>
  171.   ---------------------
  172.  
  173.    Path and name of the AmigaDOS command 'List'.  Default is 'c:list'.
  174.  
  175.    
  176.  
  177.   5.3 #RATIO <maxratio>
  178.   ---------------------
  179.  
  180.    The maximum allowable compressratio for the inbound mail-packets.
  181.  
  182.  
  183.  
  184.   5.4 #PACKER <name> <idpos> <id> <line> <position> <listcommand>
  185.   ---------------------------------------------------------------
  186.  
  187.    Configuration of archivers.  <name> is the name of the archiver.  <id> is the
  188.    archiver  specific identification string.  <idpos> specifies af what position
  189.    the  <id>-string starts.  Only the first 5 characters of the mail-packets are
  190.    checked  for  an  archiver-ID.   <listcommand>  is  the  command that must be
  191.    executed in order to generate a list of the archive contents.  Important:  it
  192.    must also include the path to the command!  <line> is the line, counting from
  193.    the  bottom,  of  the  listcommand  output  that  contains  the totals of the
  194.    archive.   <position>  numbers  the  word  on the <line>-line, that shows the
  195.    total size of the uncompressed files.
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  6. Theory of operation
  202.  ======================
  203.  
  204.   MM_AntiBomb  should  normally only be started before you unpack incoming mail.
  205.   So the #BEFORECMD in MM_ImportPlus is a good place to start it.
  206.  
  207.   You could also start it in the aftersession, but it's only nessesary to run it
  208.   when there is mail to import..
  209.  
  210.   MM_AntiBomb checks the incoming mail-packets against the configured archivers.
  211.   In  case  the  packet  is  compressed  with  a known archiver, it compares the
  212.   physical  size  of  the  packet  with the size the packet would have if it was
  213.   uncompressed.
  214.  
  215.   This compress-ratio is compared with a user configurable maximum ratio, if the
  216.   compress-ratio of the checked packet exceeds this maximum, the packet is moved
  217.   to the bad-directory, and a "BOMB_" is added in front of the packet-name.
  218.  
  219.   This  way you can avoid filling your harddisk and crashing your system, if you
  220.   receive a mailbomb.
  221.  
  222.   (A  mailbomb is an archive, that isn't very big in size, but when uncompressed
  223.   it  will  fill up to an unlimited number of megaytes!  If your mailer tries to
  224.   uncompress  such  an  archive, it will eventually fill your harddisk, and your
  225.   system will hang with the "device full - retry/cancel" requester.) :-(
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  7. Future
  232.  =========
  233.  
  234.   Ideas for the future...
  235.  
  236.      ... any ideas? Please write to me!
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  8. Acknowledgements
  243.  ===================
  244.  
  245.   My girlfriend     For  tolerating me spending too much time with my Amiga, and
  246.                     just beeing wonderful and lovely!
  247.  
  248.   Pino Aliberti     For his excellent Mail Manager!
  249.  
  250.   Robert Hofmann    For  all  his  excellent scripts for Mail Manager, including
  251.                     CompressRexx and MM_ImportPlus mentioned in this doc.
  252.                     For the MM_RexxDeveloperKit v1.11 used in the making of this
  253.                     script.
  254.                     And for the 'template' for this documentation. ;)
  255.  
  256.   Frank Schnittger  For MM_AreaManager - The best AreaFix for MailManager!
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                                     --O--
  263.  
  264.          Kent B. Hansen     2:237/30.0@fidonet      9:451/246.0@virnet
  265.           The TPV BBS      39:140/103.0@amiganet  kbh@imada.ou.dk
  266.  
  267.  
  268.